IRIX 6.5 Complementary Applications 2004 February

home *** CD-ROM | disk | FTP | other *** search

/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmMessageBox.z / XmMessageBox

Wrap

Text File | 2003-11-18 | 21.8 KB | 529 lines

XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) NNNNAAAAMMMMEEEE _X_m_M_e_s_s_a_g_e_B_o_x - The MessageBox widget class SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS #include <Xm/MessageB.h> DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN MessageBox is a dialog class used for creating simple message dialogs. Convenience dialogs based on MessageBox are provided for several common interaction tasks, which include giving information, asking questions, and reporting errors. A MessageBox dialog is typically transient in nature, displayed for the duration of a single interaction. MessageBox is a subclass of XmBulletinBoard and depends on it for much of its general dialog behavior. The default value for _X_m_N_i_n_i_t_i_a_l_F_o_c_u_s is the value of _X_m_N_d_e_f_a_u_l_t_B_u_t_t_o_n. A typical MessageBox contains a message symbol, a message, and up to three standard default PushButtons: _O_K, _C_a_n_c_e_l, and _H_e_l_p. It is laid out with the symbol and message on top and the PushButtons on the bottom. The help button is positioned to the side of the other push buttons. You can localize the default symbols and button labels for MessageBox convenience dialogs. The user can specify resources in a resource file for the gadgets created automatically that contain the MessageBox symbol pixmap and separator. The gadget names are "Symbol" and "Separator". A MessageBox can also be customized by creating and managing new children that are added to the MessageBox children created automatically by the convenience dialogs. In the case of TemplateDialog, only the separator child is created by default. If the callback, string, or pixmap symbol resources are specified, the appropriate child will be created. Additional children are laid out in the following manner: +o The first MenuBar child is placed at the top of the window. +o All _X_m_P_u_s_h_B_u_t_t_o_n widgets or gadgets, and their subclasses are placed after the _O_K button in the order of their creation. +o A child that is not in the above categories is placed Page 1 (printed 11/11/03) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) above the row of buttons. If a message label exists, the child is placed below the label. If a message pixmap exists, but a message label is absent, the child is placed on the same row as the pixmap. The child behaves as a work area and grows or shrinks to fill the space above the row of buttons. The layout of multiple work area children is undefined. At initialization, MessageBox looks for the following bitmap files: +o xm_error +o xm_information +o xm_question +o xm_working +o xm_warning See _X_m_G_e_t_P_i_x_m_a_p(_3_X) for a list of the paths that are searched for these files. CCCCllllaaaasssssssseeeessss MessageBox inherits behavior and resources from _C_o_r_e, _C_o_m_p_o_s_i_t_e, _C_o_n_s_t_r_a_i_n_t, _X_m_M_a_n_a_g_e_r, and _X_m_B_u_l_l_e_t_i_n_B_o_a_r_d. The class pointer is _x_m_M_e_s_s_a_g_e_B_o_x_W_i_d_g_e_t_C_l_a_s_s. The class name is _X_m_M_e_s_s_a_g_e_B_o_x. NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a .Xdefaults file, remove the _X_m_N or _X_m_C prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the _X_m prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using _X_t_S_e_t_V_a_l_u_e_s (S), retrieved by using _X_t_G_e_t_V_a_l_u_e_s (G), or is not applicable (N/A). XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss _____________________________________________________________________________________________ Page 2 (printed 11/11/03) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) XmNcancelCallback XmCCallback XtCallbackList NULL C XmNcancelLabelString XmCCancelLabelString XmString dynamic CSG XmNdefaultButtonType XmCDefaultButtonType unsigned char XmDIALOG_OK_BUTTON CSG XmNdialogType XmCDialogType unsigned char XmDIALOG_MESSAGE CSG XmNhelpLabelString XmCHelpLabelString XmString dynamic CSG XmNmessageAlignment XmCAlignment unsigned char XmALIGNMENT_BEGINNING CSG XmNmessageString XmCMessageString XmString "" CSG XmNminimizeButtons XmCMinimizeButtons Boolean False CSG XmNokCallback XmCCallback XtCallbackList NULL C XmNokLabelString XmCOkLabelString XmString dynamic CSG XmNsymbolPixmap XmCPixmap Pixmap dynamic CSG _X_m_N_c_a_n_c_e_l_C_a_l_l_b_a_c_k Specifies the list of callbacks that is called when the user clicks on the cancel button. The reason sent by the callback is _X_m_C_R__C_A_N_C_E_L. _X_m_N_c_a_n_c_e_l_L_a_b_e_l_S_t_r_i_n_g Specifies the string label for the cancel button. The default for this resource depends on the locale. In the C locale the default is "Cancel". _X_m_N_d_e_f_a_u_l_t_B_u_t_t_o_n_T_y_p_e Specifies the default PushButton. A value of _X_m_D_I_A_L_O_G__N_O_N_E means that there should be no default PushButton. The following are valid types: +o _X_m_D_I_A_L_O_G__C_A_N_C_E_L__B_U_T_T_O_N +o _X_m_D_I_A_L_O_G__O_K__B_U_T_T_O_N +o _X_m_D_I_A_L_O_G__H_E_L_P__B_U_T_T_O_N +o _X_m_D_I_A_L_O_G__N_O_N_E _X_m_N_d_i_a_l_o_g_T_y_p_e Specifies the type of MessageBox dialog, which determines the default message symbol. The following are the possible values for this resource: +o _X_m_D_I_A_L_O_G__E_R_R_O_R - indicates an ErrorDialog +o _X_m_D_I_A_L_O_G__I_N_F_O_R_M_A_T_I_O_N - indicates an InformationDialog +o _X_m_D_I_A_L_O_G__M_E_S_S_A_G_E - indicates a MessageDialog. This is the default MessageBox dialog type. It does not have an associated message symbol. +o _X_m_D_I_A_L_O_G__Q_U_E_S_T_I_O_N - indicates a QuestionDialog +o _X_m_D_I_A_L_O_G__T_E_M_P_L_A_T_E - indicates a TemplateDialog. The Page 3 (printed 11/11/03) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) TemplateDialog contains only a separator child. It does not have an associated message symbol. +o _X_m_D_I_A_L_O_G__W_A_R_N_I_N_G - indicates a WarningDialog +o _X_m_D_I_A_L_O_G__W_O_R_K_I_N_G - indicates a WorkingDialog If this resource is changed via _X_t_S_e_t_V_a_l_u_e_s, the symbol bitmap is modified to the new _X_m_N_d_i_a_l_o_g_T_y_p_e bitmap unless _X_m_N_s_y_m_b_o_l_P_i_x_m_a_p is also being set in the call to _X_t_S_e_t_V_a_l_u_e_s. If the dialog type does not have an associated message symbol, then no bitmap will be displayed. _X_m_N_h_e_l_p_L_a_b_e_l_S_t_r_i_n_g Specifies the string label for the help button. The default for this resource depends on the locale. In the C locale the default is "Help". _X_m_N_m_e_s_s_a_g_e_A_l_i_g_n_m_e_n_t Controls the alignment of the message Label. Possible values include the following: +o _X_m_A_L_I_G_N_M_E_N_T__B_E_G_I_N_N_I_N_G - the default +o _X_m_A_L_I_G_N_M_E_N_T__C_E_N_T_E_R +o _X_m_A_L_I_G_N_M_E_N_T__E_N_D _X_m_N_m_e_s_s_a_g_e_S_t_r_i_n_g Specifies the string to be used as the message. _X_m_N_m_i_n_i_m_i_z_e_B_u_t_t_o_n_s Sets the buttons to the width of the widest button and height of the tallest button if False. If True, button width and height are set to the preferred size of each button. _X_m_N_o_k_C_a_l_l_b_a_c_k Specifies the list of callbacks that is called when the user clicks on the OK button. The reason sent by the callback is _X_m_C_R__O_K. _X_m_N_o_k_L_a_b_e_l_S_t_r_i_n_g Specifies the string label for the OK button. The default for this resource depends on the locale. In the C locale the default is "OK". _X_m_N_s_y_m_b_o_l_P_i_x_m_a_p Specifies the pixmap label to be used as the message symbol. IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss PPPPaaaaggggeeee 4444 ((((pppprrrriiiinnnntttteeeedddd 11111111////11111111////00003333)))) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) MessageBox inherits behavior and resources from the following superclasses. For a complete description of each resource, refer to the man page for that superclass. XXXXmmmmBBBBuuuulllllllleeeettttiiiinnnnBBBBooooaaaarrrrdddd RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss __________________________________________________________________________________ XmNallowOverlap XmCAllowOverlap Boolean True CSG XmNautoUnmanage XmCAutoUnmanage Boolean True CG XmNbuttonFontList XmCButtonFontList XmFontList dynamic CSG XmNcancelButton XmCWidget Widget Cancel button SG XmNdefaultButton XmCWidget Widget dynamic SG XmNdefaultPosition XmCDefaultPosition Boolean True CSG XmNdialogStyle XmCDialogStyle unsigned char dynamic CSG XmNdialogTitle XmCDialogTitle XmString NULL CSG XmNfocusCallback XmCCallback XtCallbackList NULL C XmNlabelFontList XmCLabelFontList XmFontList dynamic CSG XmNmapCallback XmCCallback XtCallbackList NULL C XmNmarginHeight XmCMarginHeight Dimension 10 CSG XmNmarginWidth XmCMarginWidth Dimension 10 CSG XmNnoResize XmCNoResize Boolean False CSG XmNresizePolicy XmCResizePolicy unsigned char XmRESIZE_ANY CSG XmNshadowType XmCShadowType unsigned char XmSHADOW_OUT CSG XmNtextFontList XmCTextFontList XmFontList dynamic CSG XmNtextTranslations XmCTranslations XtTranslations NULL C XmNunmapCallback XmCCallback XtCallbackList NULL C XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss _________________________________________________________________________________________________ XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNforeground XmCForeground Pixel dynamic CSG XmNhelpCallback XmCCallback XtCallbackList NULL C XmNhighlightColor XmCHighlightColor Pixel dynamic CSG XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG XmNinitialFocus XmCInitialFocus Widget dynamic CSG XmNnavigationType XmCNavigationType XmNavigationType XmTAB_GROUP CSG XmNshadowThickness XmCShadowThickness Dimension dynamic CSG XmNstringDirection XmCStringDirection XmStringDirection dynamic CG XmNtopShadowColor XmCTopShadowColor Pixel dynamic CSG XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG XmNtraversalOn XmCTraversalOn Boolean True CSG XmNunitType XmCUnitType unsigned char dynamic CSG XmNuserData XmCUserData XtPointer NULL CSG CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss Page 5 (printed 11/11/03) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) ______________________________________________________________________ XmNchildren XmCReadOnly WidgetList NULL G XmNinsertPosition XmCInsertPosition XtOrderProc NULL CSG XmNnumChildren XmCReadOnly Cardinal 0 G CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss ______________________________________________________________________________________________________________ XmNaccelerators XmCAccelerators XtAccelerators dynamic N/A XmNancestorSensitive XmCSensitive Boolean dynamic G XmNbackground XmCBackground Pixel dynamic CSG XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderWidth XmCBorderWidth Dimension 0 CSG XmNcolormap XmCColormap Colormap dynamic CG XmNdepth XmCDepth int dynamic CG XmNdestroyCallback XmCCallback XtCallbackList NULL C XmNheight XmCHeight Dimension dynamic CSG XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG XmNscreen XmCScreen Screen * dynamic CG XmNsensitive XmCSensitive Boolean True CSG XmNtranslations XmCTranslations XtTranslations dynamic CSG XmNwidth XmCWidth Dimension dynamic CSG XmNx XmCPosition Position 0 CSG XmNy XmCPosition Position 0 CSG CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn A pointer to the following structure is passed to each callback: typedef struct { int rrrreeeeaaaassssoooonnnn; _X_E_v_e_n_t **** eeeevvvveeeennnntttt; } _X_m_A_n_y_C_a_l_l_b_a_c_k_S_t_r_u_c_t; rrrreeeeaaaassssoooonnnn Indicates why the callback was invoked eeeevvvveeeennnntttt Points to the _X_E_v_e_n_t that triggered the callback TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss Page 6 (printed 11/11/03) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) XmMessageBox includes the translations from XmManager. AAAAddddddddiiiittttiiiioooonnnnaaaallll BBBBeeeehhhhaaaavvvviiiioooorrrr The XmMessageBox widget has the additional behavior described below: _M_A_n_y _K_C_a_n_c_e_l: Calls the activate callbacks for the cancel button if it is sensitive. _K_A_c_t_i_v_a_t_e: Calls the activate callbacks for the button with the keyboard focus. If no button has the keyboard focus, calls the activate callbacks for the default button if it is sensitive. <_O_k _B_u_t_t_o_n _A_c_t_i_v_a_t_e_d>: Calls the callbacks for _X_m_N_o_k_C_a_l_l_b_a_c_k. <_C_a_n_c_e_l _B_u_t_t_o_n _A_c_t_i_v_a_t_e_d>: Calls the callbacks for _X_m_N_c_a_n_c_e_l_C_a_l_l_b_a_c_k. <_H_e_l_p _B_u_t_t_o_n _A_c_t_i_v_a_t_e_d>: Calls the callbacks for _X_m_N_h_e_l_p_C_a_l_l_b_a_c_k. <_F_o_c_u_s_I_n>: Calls the callbacks for _X_m_N_f_o_c_u_s_C_a_l_l_b_a_c_k. <_M_a_p>: Calls the callbacks for _X_m_N_m_a_p_C_a_l_l_b_a_c_k if the parent is a DialogShell. <_U_n_m_a_p>: Calls the callbacks for _X_m_N_u_n_m_a_p_C_a_l_l_b_a_c_k if the parent is a DialogShell. VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss The bindings for virtual keys are vendor specific. For information about bindings for virtual buttons and keys, see Page 7 (printed 11/11/03) XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmMMMMeeeessssssssaaaaggggeeeeBBBBooooxxxx((((3333XXXX)))) _V_i_r_t_u_a_l_B_i_n_d_i_n_g_s(_3_X). RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN _C_o_m_p_o_s_i_t_e(_3_X), _C_o_n_s_t_r_a_i_n_t(_3_X), _C_o_r_e(_3_X), _X_m_B_u_l_l_e_t_i_n_B_o_a_r_d(_3_X), _X_m_C_r_e_a_t_e_E_r_r_o_r_D_i_a_l_o_g(_3_X), _X_m_C_r_e_a_t_e_I_n_f_o_r_m_a_t_i_o_n_D_i_a_l_o_g(_3_X), _X_m_C_r_e_a_t_e_M_e_s_s_a_g_e_B_o_x(_3_X), _X_m_C_r_e_a_t_e_M_e_s_s_a_g_e_D_i_a_l_o_g(_3_X), _X_m_C_r_e_a_t_e_Q_u_e_s_t_i_o_n_D_i_a_l_o_g(_3_X), _X_m_C_r_e_a_t_e_T_e_m_p_l_a_t_e_D_i_a_l_o_g(_3_X), _X_m_C_r_e_a_t_e_W_a_r_n_i_n_g_D_i_a_l_o_g(_3_X), _X_m_C_r_e_a_t_e_W_o_r_k_i_n_g_D_i_a_l_o_g(_3_X), _X_m_M_a_n_a_g_e_r(_3_X), and _X_m_M_e_s_s_a_g_e_B_o_x_G_e_t_C_h_i_l_d(_3_X). Page 8 (printed 11/11/03)